<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>bram: xbram.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">bram
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xbram_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xbram.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_bram___config.html">XBram_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains configuration information for the device.  <a href="struct_x_bram___config.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_bram.html">XBram</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="struct_x_bram.html" title="The XBram driver instance data. ">XBram</a> driver instance data.  <a href="struct_x_bram.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gab4bacc0667e96732958979264a8a1296"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_bram___config.html">XBram_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bram.html#gab4bacc0667e96732958979264a8a1296">XBram_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:gab4bacc0667e96732958979264a8a1296"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lookup the device configuration based on the unique device ID.  <a href="group__bram.html#gab4bacc0667e96732958979264a8a1296">More...</a><br/></td></tr>
<tr class="separator:gab4bacc0667e96732958979264a8a1296"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab305438b0844ddb20139878c21ef0e6b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bram.html#gab305438b0844ddb20139878c21ef0e6b">XBram_CfgInitialize</a> (<a class="el" href="struct_x_bram.html">XBram</a> *InstancePtr, <a class="el" href="struct_x_bram___config.html">XBram_Config</a> *Config, UINTPTR EffectiveAddr)</td></tr>
<tr class="memdesc:gab305438b0844ddb20139878c21ef0e6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the <a class="el" href="struct_x_bram.html" title="The XBram driver instance data. ">XBram</a> instance provided by the caller based on the given configuration data.  <a href="group__bram.html#gab305438b0844ddb20139878c21ef0e6b">More...</a><br/></td></tr>
<tr class="separator:gab305438b0844ddb20139878c21ef0e6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaedbdefb6cda5c212f03271143ccf7a98"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bram.html#gaedbdefb6cda5c212f03271143ccf7a98">XBram_SelfTest</a> (<a class="el" href="struct_x_bram.html">XBram</a> *InstancePtr, u8 IntMask)</td></tr>
<tr class="memdesc:gaedbdefb6cda5c212f03271143ccf7a98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run a self-test on the driver/device.  <a href="group__bram.html#gaedbdefb6cda5c212f03271143ccf7a98">More...</a><br/></td></tr>
<tr class="separator:gaedbdefb6cda5c212f03271143ccf7a98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4210a263bd85db259a74c20cd0b0176c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bram.html#ga4210a263bd85db259a74c20cd0b0176c">XBram_InterruptEnable</a> (<a class="el" href="struct_x_bram.html">XBram</a> *InstancePtr, u32 Mask)</td></tr>
<tr class="memdesc:ga4210a263bd85db259a74c20cd0b0176c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable interrupts.  <a href="group__bram.html#ga4210a263bd85db259a74c20cd0b0176c">More...</a><br/></td></tr>
<tr class="separator:ga4210a263bd85db259a74c20cd0b0176c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9ce680e885511fdd26b6818b71b145c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bram.html#ga9ce680e885511fdd26b6818b71b145c4">XBram_InterruptDisable</a> (<a class="el" href="struct_x_bram.html">XBram</a> *InstancePtr, u32 Mask)</td></tr>
<tr class="memdesc:ga9ce680e885511fdd26b6818b71b145c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable interrupts.  <a href="group__bram.html#ga9ce680e885511fdd26b6818b71b145c4">More...</a><br/></td></tr>
<tr class="separator:ga9ce680e885511fdd26b6818b71b145c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa4ac1ca5c9c05eabbdea77f35ba9ac5a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bram.html#gaa4ac1ca5c9c05eabbdea77f35ba9ac5a">XBram_InterruptClear</a> (<a class="el" href="struct_x_bram.html">XBram</a> *InstancePtr, u32 Mask)</td></tr>
<tr class="memdesc:gaa4ac1ca5c9c05eabbdea77f35ba9ac5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear pending interrupts with the provided mask.  <a href="group__bram.html#gaa4ac1ca5c9c05eabbdea77f35ba9ac5a">More...</a><br/></td></tr>
<tr class="separator:gaa4ac1ca5c9c05eabbdea77f35ba9ac5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafec7418ceae662672c03a938290da9dd"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bram.html#gafec7418ceae662672c03a938290da9dd">XBram_InterruptGetEnabled</a> (<a class="el" href="struct_x_bram.html">XBram</a> *InstancePtr)</td></tr>
<tr class="memdesc:gafec7418ceae662672c03a938290da9dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the interrupt enable mask.  <a href="group__bram.html#gafec7418ceae662672c03a938290da9dd">More...</a><br/></td></tr>
<tr class="separator:gafec7418ceae662672c03a938290da9dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3880bb684ad362c6bd289f3e76a98b59"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bram.html#ga3880bb684ad362c6bd289f3e76a98b59">XBram_InterruptGetStatus</a> (<a class="el" href="struct_x_bram.html">XBram</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga3880bb684ad362c6bd289f3e76a98b59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the status of interrupt signals.  <a href="group__bram.html#ga3880bb684ad362c6bd289f3e76a98b59">More...</a><br/></td></tr>
<tr class="separator:ga3880bb684ad362c6bd289f3e76a98b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
